home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 2.iso / toolbox / public / figlet / figlet2.1.1 / README < prev    next >
Text File  |  1996-11-11  |  10KB  |  234 lines
  1. About figlet (Frank, Ian & Glenn's Letters) release 2.1.1, 28 Apr 1995
  2. ----------------------------------------------------------------------
  3.  
  4. Note: figlet 2.1.1 is a minor revision of figlet 2.1.  The files
  5. FTP-NOTE, README, chkfont.c, figlet.c, figlist and showfigfonts have
  6. been changed.  All other files are identical with the 2.1 release.
  7.  
  8. For those making figlet 2.1.1 available by anonymous FTP: please put
  9. the version number (2.1.1) in the filename, so that FTP'ers can know
  10. they're not getting the same program they already have.
  11.  
  12. ----------------------------------------------------------------------
  13.  
  14. figlet is a program that creates large characters out of ordinary
  15. screen characters
  16.  _ _ _          _   _     _       
  17. | (_) | _____  | |_| |__ (_)___   
  18. | | | |/ / _ \ | __| '_ \| / __|  
  19. | | |   <  __/ | |_| | | | \__ \_ 
  20. |_|_|_|\_\___|  \__|_| |_|_|___(_)
  21.                                   
  22. (This is meant to be viewed in a monospaced font.)  figlet can create
  23. characters in many different styles and can kern and "smush" these
  24. characters together in various ways.  figlet output is generally
  25. reminiscent of the sort of "signatures" many people like to put at the
  26. end of e-mail and UseNet messages.
  27.  
  28. If you like figlet (hey, even if you _hate_ figlet), please send an
  29. e-mail message to <figlet@uiuc.edu>.
  30.  
  31.  
  32. What's New in figlet 2.1
  33. ------------------------
  34.  
  35. (If you are new to figlet, you may want to skip this section.)
  36.  
  37. - Bug Fixes
  38. A number of minor bugs and major incompatibility problems have been
  39. fixed.  figlet 2.1 should compile correctly on many operating systems for
  40. which figlet 2.0 did not.
  41.  
  42. - "-F" removed
  43. The "-F" command line option, which used to list all the available
  44. fonts, has been removed, since it made figlet incompatible with some
  45. operating systems.  It has been replaced by the "figlist" script.  The
  46. "showfigfonts" script has been updated so that it no longer requires
  47. the "-F" option to be available.
  48.  
  49. - Extended character set
  50. The figlet font file format has been extended to allow an arbitrarily
  51. large number of characters.  The ISO Latin-1 character set, which
  52. includes many accented letters and special symbols, has been added to
  53. most standard fonts.
  54.  
  55. - Right-to-left printing
  56. figlet can now print right-to-left.  This can be specified on the
  57. command line ("-R") or in the font file.  Thus, for example, Hebrew and
  58. Arabic fonts can be handled more easily.
  59.  
  60. - Right-justified text
  61. figlet can now right justify its output.  This is the default when
  62. right-to-left printing is selected.  It can also be specified on the
  63. command line ("-r").
  64.  
  65. - Control files
  66. figlet now supports "control files".  These can be used to change which
  67. character figlet will print when it sees a certain input character --
  68. sort of an expanded version of the "-D" option.  For example, a control
  69. file could convert lower-case letters to upper-case or map certain
  70. ASCII characters to accented letters.  Control file names end with the
  71. suffix ".flc".  Select a control file by using "-C controlfile" on the
  72. command line.  Several controlfiles can be used at once by giving
  73. muliple "-C" options.
  74.  
  75. - Utility Interface
  76. There is now a way for programs that use figlet to get various
  77. information from figlet, for example, what version of figlet is being
  78. used or the name of the default font directory.  This information is
  79. gotten through the "-I" option.  See the man page for details.
  80.  
  81.  
  82. Other Fonts, Mailing List & Web Page
  83. ------------------------------------
  84.  
  85. A good number of figlet fonts have been developed, most of which are
  86. not included in the standard figlet package.  Many of these can be
  87. obtained by anonymous FTP from ftp.nicoh.com in the directory
  88. "pub/figlet/fonts".  Some non-Roman fonts are available at the FTP
  89. site.  As of this writing, we have Hebrew, Cyrillic (Russian) and
  90. Greek.
  91.  
  92. We run an e-mail list dedicated to figlet software and font
  93. announcements, as well as general discussion about figlet.  If you
  94. would like to be on this list, send e-mail to listserv@vmd.cso.uiuc.edu
  95. with the message body
  96.         subscribe figlet-l YOUR NAME
  97. where YOUR NAME should be replaced with your name.  For those who don't
  98. want to be bothered with the discussions, the list can be configured so
  99. that you only see software update notices, or only software and font
  100. announcements.
  101.  
  102. We also maintain a "Figlet Home Page" on the Worldwide Web. The URL is
  103. http://www.math.uiuc.edu/~chappell/figlet
  104.  
  105.  
  106. Files
  107. -----
  108.  
  109. README       -- This file.
  110. figlet.c     -- The figlet source code.
  111. Makefile     -- The figlet makefile.  Used by the make command.
  112. figlet.6     -- The figlet man(ual) page.
  113. figlist      -- Script that lists available fonts and control files.
  114. showfigfonts -- Script that gives a sample of each available font.
  115. chkfont.c    -- Source code for chkfont: a program that checks figlet
  116.                 fonts for formatting errors.  You can ignore this file
  117.                 unless you intend to design or edit fonts.
  118. fonts        -- Directory containing fonts and control files.
  119. <xxx>.flf    -- All files ending in ".flf" are figlet font files.
  120. <xxx>.flc    -- All files ending in ".flc" are figlet control files.
  121.  
  122.  
  123. Installing figlet
  124. -----------------
  125.  
  126. First decide in which directories figlet and the figlet font files
  127. (the ".flf" files) will be stored (we recommend "/usr/games" and
  128. "/usr/games/lib/figlet.dir", respectively) and which will be the
  129. default font (we recommend "standard.flf").
  130.  
  131. Edit "Makefile", and set the variables DEFAULTFONTDIR and
  132. DEFAULTFONTFILE to the appropriate values.  Set DEFAULTFONTDIR to be
  133. the full pathname of the directory in which you will keep the figlet
  134. font files.  Set DEFAULTFONTFILE to be the filename of the default
  135. font.
  136.  
  137. At this point, you have 2 choices:
  138.  
  139. (1) Just compile figlet.  To go this, go into the directory containing
  140. the figlet source, and type "make figlet".  Then copy the various files
  141. to the proper locations.  The executable (figlet), along with figlist
  142. and showfigfonts, goes wherever you keep your executables.  The fonts
  143. (<xxx>.flf) and control files (<xxx>.flc) go in the default font
  144. directory.  The man page (figlet.6) goes in section 6 (usually
  145. /usr/man/man6).  If you cannot, or do not want to, install the man page,
  146. you can probably still read it using
  147.         nroff -man figlet.6 | more
  148.  
  149. (2) Do a complete installation.  To do the this, set the variables
  150. DESTDIR and MANDIR in Makefile to the appropriate values.  DESTDIR
  151. should be the full pathname of the directory in which the executable
  152. files should be put (we recommend "/usr/games");  MANDIR should be the
  153. full pathname of the directory in which the figlet man page should be
  154. put, generally "/usr/man/man6".  Once DEFAULTFONTDIR, DEFAULTFONTFILE,
  155. DESTDIR and MANDIR have been set, in the directory containing the figlet
  156. source, type "make install".
  157.  
  158. If space is a problem, the only files you absolutely must have to run
  159. figlet are "figlet" (the executable) and at least one font (preferably
  160. the one you chose to be the default font).
  161.  
  162.  
  163. Using figlet
  164. ------------
  165.  
  166. (Note: figlet needs a good thorough tutorial.  Currently I don't have
  167. the time to write one, but if anyone wants to do so, go right ahead.
  168. I'd be glad to help out a little.  Write us at <figlet@uiuc.edu> if
  169. you're interested.  -GGC-)
  170.  
  171. At the shell prompt, type "figlet".  Then type, say, "Hello, world!"
  172. and press return.  "Hello, world!" in nice, big, designer characters
  173. should appear on your screen.  If you chose standard.flf to be the
  174. default font, you should see
  175.  _   _      _ _                             _     _ _ 
  176. | | | | ___| | | ___    __      _____  _ __| | __| | |
  177. | |_| |/ _ \ | |/ _ \   \ \ /\ / / _ \| '__| |/ _` | |
  178. |  _  |  __/ | | (_) |   \ V  V / (_) | |  | | (_| |_|
  179. |_| |_|\___|_|_|\___( )   \_/\_/ \___/|_|  |_|\__,_(_)
  180.                     |/                                
  181. Then type something else, or type an EOF (typically control-D) to quit
  182. figlet.
  183.  
  184. Now you can send the output of figlet to a file (e.g., "figlet > file")
  185. and e-mail it to your friends (who will probably say, "Wow!  It must
  186. have taken you hours to put that together!")
  187.  
  188. To use other fonts, use the "-f" command line option.  For example, if
  189. you had said "figlet -f smslant" above, you would have seen
  190.    __ __    ____                         __   ____
  191.   / // /__ / / /__      _    _____  ____/ /__/ / /
  192.  / _  / -_) / / _ \_   | |/|/ / _ \/ __/ / _  /_/ 
  193. /_//_/\__/_/_/\___( )  |__,__/\___/_/ /_/\_,_(_)  
  194.                   |/                              
  195.  
  196. Here are some other useful command line options:
  197.  
  198. -c   center -- centers the output of figlet.
  199. -m0  (that's a zero) tells figlet to kern characters without smushing
  200.      them together.
  201. -t   terminal -- figlet asks your terminal how wide it is, and uses
  202.      this to determine when to break lines.  Normally, figlet assumes
  203.      80 columns so that people with wide terminals won't annoy the
  204.      people they e-mail figlet output to.
  205. -p   paragraph mode -- eliminates some spurious line breaks when piping
  206.      a multi-line file through figlet.
  207. -v   version -- prints information about your copy of figlet.
  208.  
  209. For in-depth explanations of these and other options, see the man page.
  210.  
  211.  
  212. Other Stuff
  213. -----------
  214.  
  215. figlet is available for operating systems other than Unix.  E-mail us
  216. for more information.
  217.  
  218. Although you don't have to design your own fonts to use figlet, we'd
  219. certainly like it if lots of people did make up new figlet fonts.  If
  220. you feel like giving it a try, see the "FONT FILE FORMAT" section of
  221. the man page.  If you do design a font, please let us know!
  222.  
  223. See "Other Things to Try" in the EXAMPLES section of the man page
  224. for... well... other things to try.
  225.  
  226.  
  227. Authors
  228. -------
  229.  
  230. figlet was written mostly by Glenn Chappell <ggc@uiuc.edu>.  The author
  231. not being an e-mail fanatic, most correspondence (bug reports, rave
  232. reviews, etc.) should be directed to his secretary (who is definitely
  233. an e-mail fanatic), Ian Chai <spectre@uiuc.edu>.
  234.